Skip to main content

Get order

GET 
/bot-gateway-service/api/v3/order

Provides an order's information.

Request​

Query Parameters

    Symbol string

    Symbol of the trading pair (e.g., XCBETH) (optional).

    Example: XCBETH
    OrderId int64

    The unique identifier of the order of type big integer generated by the Ping Exchange (optional).

    • Note: To get an order, either of OrderId or OrigClientOrderId should be provided in the cancel request.
    Example: 5343
    OrigClientOrderId string

    The unique identifier (Guid) assigned by the client for the order (optional).

    • It is the client’s original ClientOrderId when submitting a new order.
    Example: 09D6C415-996F-4FBA-8C52-22F08D7AF53E
    RecvWindow int64

    The number of milliseconds after timestamp the request is valid for (optional).

    • RecvWindow is optional.
    • The value cannot be greater than 60000.
    • If recvWindow is not sent, it defaults to 5000.
    Example: 60000

Responses​

Success

Schema

    symbol stringnullable

    Symbol of the trading pair (e.g., XCBETH).

    orderId int64

    The unique identifier of the order of type big integer generated by the Ping Exchange.

    orderListId int64

    The unique identifier of the order list generated by the Ping Exchange.

    • Unless OCO, value will be -1
    clientOrderId stringnullable

    The unique identifier (Guid) assigned by the client for the order.

    • It is the client’s original ClientOrderId of the order from the request.
    price stringnullable

    The price is the client’s original price of the order from the request.

    origQty stringnullable

    The original quantity requested by the client.

    executedQty stringnullable

    The quantity of the base asset that has been executed in the order (e.g., 0.5).

    • executedQty is how many base asset is matched in the order, which is 0.5 in the above example.
    cummulativeQuoteQty stringnullable

    The total cost of buying the base asset in the quote asset.

    • It is how much the user paid for buying base asset in quote asset.
    status stringnullable

    The status of the order.

    • Possible values:
      • NEW
      • PARTIALLY_FILLED
      • FILLED
      • CANCELED
      • REJECTED
      • EXPIRED
    timeInForce stringnullable

    Order time in force.

    • Possible values:
      • Good till Canceled (GTC)
      • Immediate or Cancel (IOC)
      • Fill-Or-Kill (FOK)
    type stringnullable

    Order type , e.g. LIMIT.

    • Possible values:
      • LIMIT
      • MARKET
      • STOP_LOSS_LIMIT
      • TAKE_PROFIT_LIMIT
      • STOP_LOSS_LIMIT
      • LIMIT_MAKER
      • STOP_LOSS
      • TAKE_PROFIT
    side stringnullable

    Order side: e.g. BUY or SELL.

    stopPrice stringnullable

    The stop order activation price.

    • Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
    icebergQty stringnullable

    The quantity of the iceberg order.

    • Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
    transactTime int64

    The timestamp of the transaction.

    updateTime int64

    The timestamp of the last update.

    isWorking boolean

    Indicates if the order is currently placed in the order book or not.

    • It’s the same “w” field returned from websocket executionReport event.
    workingTime int64

    The time when the order was last marked as working.

    origQuoteOrderQty stringnullable

    The original quote order quantity.

    selfTradePreventionMode stringnullable

    The mode for self-trade prevention.

    • Possible values: NONE, EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH
Loading...